4 * The parent class to generate form fields. Any field type should
5 * be a subclass of this.
7 abstract class HTMLFormField
{
10 protected $mValidationCallback;
11 protected $mFilterCallback;
14 protected $mLabel; # String label, as HTML. Set on construction.
16 protected $mClass = '';
17 protected $mVFormClass = '';
18 protected $mHelpClass = false;
21 * @var array|bool|null
23 protected $mOptions = false;
24 protected $mOptionsLabelsNotFromMessage = false;
25 protected $mHideIf = null;
28 * @var bool If true will generate an empty div element with no label
31 protected $mShowEmptyLabels = true;
39 * This function must be implemented to return the HTML to generate
40 * the input object itself. It should not implement the surrounding
41 * table cells/rows, or labels/help messages.
43 * @param string $value The value to set the input to; eg a default
44 * text for a text input.
46 * @return string Valid HTML.
48 abstract public function getInputHTML( $value );
51 * Same as getInputHTML, but returns an OOUI object.
52 * Defaults to false, which getOOUI will interpret as "use the HTML version"
54 * @param string $value
55 * @return OOUI\Widget|false
57 public function getInputOOUI( $value ) {
62 * True if this field type is able to display errors; false if validation errors need to be
63 * displayed in the main HTMLForm error area.
66 public function canDisplayErrors() {
67 return $this->hasVisibleOutput();
71 * Get a translated interface message
73 * This is a wrapper around $this->mParent->msg() if $this->mParent is set
74 * and wfMessage() otherwise.
76 * Parameters are the same as wfMessage().
80 public function msg() {
81 $args = func_get_args();
83 if ( $this->mParent
) {
84 return $this->mParent
->msg( ...$args );
86 return wfMessage( ...$args );
90 * If this field has a user-visible output or not. If not,
91 * it will not be rendered
95 public function hasVisibleOutput() {
100 * Fetch a field value from $alldata for the closest field matching a given
103 * This is complex because it needs to handle array fields like the user
104 * would expect. The general algorithm is to look for $name as a sibling
105 * of $this, then a sibling of $this's parent, and so on. Keeping in mind
106 * that $name itself might be referencing an array.
108 * @param array $alldata
109 * @param string $name
112 protected function getNearestFieldByName( $alldata, $name ) {
115 while ( preg_match( '/^(.+)\[([^\]]+)\]$/', $tmp, $m ) ) {
116 array_unshift( $thisKeys, $m[2] );
119 if ( substr( $tmp, 0, 2 ) == 'wp' &&
120 !array_key_exists( $tmp, $alldata ) &&
121 array_key_exists( substr( $tmp, 2 ), $alldata )
123 // Adjust for name mangling.
124 $tmp = substr( $tmp, 2 );
126 array_unshift( $thisKeys, $tmp );
130 while ( preg_match( '/^(.+)\[([^\]]+)\]$/', $tmp, $m ) ) {
131 array_unshift( $nameKeys, $m[2] );
134 array_unshift( $nameKeys, $tmp );
137 for ( $i = count( $thisKeys ) - 1; $i >= 0; $i-- ) {
138 $keys = array_merge( array_slice( $thisKeys, 0, $i ), $nameKeys );
141 $key = array_shift( $keys );
142 if ( !is_array( $data ) ||
!array_key_exists( $key, $data ) ) {
147 $testValue = (string)$data;
155 * Helper function for isHidden to handle recursive data structures.
157 * @param array $alldata
158 * @param array $params
160 * @throws MWException
162 protected function isHiddenRecurse( array $alldata, array $params ) {
163 $origParams = $params;
164 $op = array_shift( $params );
169 foreach ( $params as $i => $p ) {
170 if ( !is_array( $p ) ) {
171 throw new MWException(
172 "Expected array, found " . gettype( $p ) . " at index $i"
175 if ( !$this->isHiddenRecurse( $alldata, $p ) ) {
182 foreach ( $params as $i => $p ) {
183 if ( !is_array( $p ) ) {
184 throw new MWException(
185 "Expected array, found " . gettype( $p ) . " at index $i"
188 if ( $this->isHiddenRecurse( $alldata, $p ) ) {
195 foreach ( $params as $i => $p ) {
196 if ( !is_array( $p ) ) {
197 throw new MWException(
198 "Expected array, found " . gettype( $p ) . " at index $i"
201 if ( !$this->isHiddenRecurse( $alldata, $p ) ) {
208 foreach ( $params as $i => $p ) {
209 if ( !is_array( $p ) ) {
210 throw new MWException(
211 "Expected array, found " . gettype( $p ) . " at index $i"
214 if ( $this->isHiddenRecurse( $alldata, $p ) ) {
221 if ( count( $params ) !== 1 ) {
222 throw new MWException( "NOT takes exactly one parameter" );
225 if ( !is_array( $p ) ) {
226 throw new MWException(
227 "Expected array, found " . gettype( $p ) . " at index 0"
230 return !$this->isHiddenRecurse( $alldata, $p );
234 if ( count( $params ) !== 2 ) {
235 throw new MWException( "$op takes exactly two parameters" );
237 list( $field, $value ) = $params;
238 if ( !is_string( $field ) ||
!is_string( $value ) ) {
239 throw new MWException( "Parameters for $op must be strings" );
241 $testValue = $this->getNearestFieldByName( $alldata, $field );
244 return ( $value === $testValue );
246 return ( $value !== $testValue );
250 throw new MWException( "Unknown operation" );
252 } catch ( Exception
$ex ) {
253 throw new MWException(
254 "Invalid hide-if specification for $this->mName: " .
255 $ex->getMessage() . " in " . var_export( $origParams, true ),
262 * Test whether this field is supposed to be hidden, based on the values of
263 * the other form fields.
266 * @param array $alldata The data collected from the form
269 public function isHidden( $alldata ) {
270 if ( !$this->mHideIf
) {
274 return $this->isHiddenRecurse( $alldata, $this->mHideIf
);
278 * Override this function if the control can somehow trigger a form
279 * submission that shouldn't actually submit the HTMLForm.
282 * @param string|array $value The value the field was submitted with
283 * @param array $alldata The data collected from the form
285 * @return bool True to cancel the submission
287 public function cancelSubmit( $value, $alldata ) {
292 * Override this function to add specific validation checks on the
293 * field input. Don't forget to call parent::validate() to ensure
294 * that the user-defined callback mValidationCallback is still run
296 * @param string|array $value The value the field was submitted with
297 * @param array $alldata The data collected from the form
299 * @return bool|string|Message True on success, or String/Message error to display, or
300 * false to fail validation without displaying an error.
302 public function validate( $value, $alldata ) {
303 if ( $this->isHidden( $alldata ) ) {
307 if ( isset( $this->mParams
['required'] )
308 && $this->mParams
['required'] !== false
311 return $this->msg( 'htmlform-required' );
314 if ( isset( $this->mValidationCallback
) ) {
315 return ( $this->mValidationCallback
)( $value, $alldata, $this->mParent
);
321 public function filter( $value, $alldata ) {
322 if ( isset( $this->mFilterCallback
) ) {
323 $value = ( $this->mFilterCallback
)( $value, $alldata, $this->mParent
);
330 * Should this field have a label, or is there no input element with the
331 * appropriate id for the label to point to?
333 * @return bool True to output a label, false to suppress
335 protected function needsLabel() {
340 * Tell the field whether to generate a separate label element if its label
345 * @param bool $show Set to false to not generate a label.
348 public function setShowEmptyLabel( $show ) {
349 $this->mShowEmptyLabels
= $show;
353 * Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to
354 * just view it? This can't normally be distinguished for e.g. checkboxes.
356 * Returns true if the request has a field for a CSRF token (wpEditToken) or a form identifier
357 * (wpFormIdentifier).
359 * @param WebRequest $request
362 protected function isSubmitAttempt( WebRequest
$request ) {
363 return $request->getCheck( 'wpEditToken' ) ||
$request->getCheck( 'wpFormIdentifier' );
367 * Get the value that this input has been set to from a posted form,
368 * or the input's default value if it has not been set.
370 * @param WebRequest $request
371 * @return string The value
373 public function loadDataFromRequest( $request ) {
374 if ( $request->getCheck( $this->mName
) ) {
375 return $request->getText( $this->mName
);
377 return $this->getDefault();
382 * Initialise the object
384 * @param array $params Associative Array. See HTMLForm doc for syntax.
386 * @since 1.22 The 'label' attribute no longer accepts raw HTML, use 'label-raw' instead
387 * @throws MWException
389 public function __construct( $params ) {
390 $this->mParams
= $params;
392 if ( isset( $params['parent'] ) && $params['parent'] instanceof HTMLForm
) {
393 $this->mParent
= $params['parent'];
396 # Generate the label from a message, if possible
397 if ( isset( $params['label-message'] ) ) {
398 $this->mLabel
= $this->getMessage( $params['label-message'] )->parse();
399 } elseif ( isset( $params['label'] ) ) {
400 if ( $params['label'] === ' ' ||
$params['label'] === "\u{00A0}" ) {
401 // Apparently some things set   directly and in an odd format
402 $this->mLabel
= "\u{00A0}";
404 $this->mLabel
= htmlspecialchars( $params['label'] );
406 } elseif ( isset( $params['label-raw'] ) ) {
407 $this->mLabel
= $params['label-raw'];
410 $this->mName
= "wp{$params['fieldname']}";
411 if ( isset( $params['name'] ) ) {
412 $this->mName
= $params['name'];
415 if ( isset( $params['dir'] ) ) {
416 $this->mDir
= $params['dir'];
419 $validName = urlencode( $this->mName
);
420 $validName = str_replace( [ '%5B', '%5D' ], [ '[', ']' ], $validName );
421 if ( $this->mName
!= $validName && !isset( $params['nodata'] ) ) {
422 throw new MWException( "Invalid name '{$this->mName}' passed to " . __METHOD__
);
425 $this->mID
= "mw-input-{$this->mName}";
427 if ( isset( $params['default'] ) ) {
428 $this->mDefault
= $params['default'];
431 if ( isset( $params['id'] ) ) {
433 $validId = urlencode( $id );
435 if ( $id != $validId ) {
436 throw new MWException( "Invalid id '$id' passed to " . __METHOD__
);
442 if ( isset( $params['cssclass'] ) ) {
443 $this->mClass
= $params['cssclass'];
446 if ( isset( $params['csshelpclass'] ) ) {
447 $this->mHelpClass
= $params['csshelpclass'];
450 if ( isset( $params['validation-callback'] ) ) {
451 $this->mValidationCallback
= $params['validation-callback'];
454 if ( isset( $params['filter-callback'] ) ) {
455 $this->mFilterCallback
= $params['filter-callback'];
458 if ( isset( $params['hidelabel'] ) ) {
459 $this->mShowEmptyLabels
= false;
462 if ( isset( $params['hide-if'] ) ) {
463 $this->mHideIf
= $params['hide-if'];
466 if ( isset( $this->mParams
['notice-message'] ) ) {
467 wfDeprecated( "'notice-message' parameter in HTMLForm", '1.32' );
469 if ( isset( $this->mParams
['notice-messages'] ) ) {
470 wfDeprecated( "'notice-messages' parameter in HTMLForm", '1.32' );
472 if ( isset( $this->mParams
['notice'] ) ) {
473 wfDeprecated( "'notice' parameter in HTMLForm", '1.32' );
478 * Get the complete table row for the input, including help text,
479 * labels, and whatever.
481 * @param string $value The value to set the input to.
483 * @return string Complete HTML table row.
485 public function getTableRow( $value ) {
486 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
487 $inputHtml = $this->getInputHTML( $value );
488 $fieldType = static::class;
489 $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
490 $cellAttributes = [];
494 if ( !empty( $this->mParams
['vertical-label'] ) ) {
495 $cellAttributes['colspan'] = 2;
496 $verticalLabel = true;
498 $verticalLabel = false;
501 $label = $this->getLabelHtml( $cellAttributes );
503 $field = Html
::rawElement(
505 [ 'class' => 'mw-input' ] +
$cellAttributes,
506 $inputHtml . "\n$errors"
509 if ( $this->mHideIf
) {
510 $rowAttributes['data-hide-if'] = FormatJson
::encode( $this->mHideIf
);
511 $rowClasses .= ' mw-htmlform-hide-if';
514 if ( $verticalLabel ) {
515 $html = Html
::rawElement( 'tr',
516 $rowAttributes +
[ 'class' => "mw-htmlform-vertical-label $rowClasses" ], $label );
517 $html .= Html
::rawElement( 'tr',
519 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
524 Html
::rawElement( 'tr',
526 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
531 return $html . $helptext;
535 * Get the complete div for the input, including help text,
536 * labels, and whatever.
539 * @param string $value The value to set the input to.
541 * @return string Complete HTML table row.
543 public function getDiv( $value ) {
544 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
545 $inputHtml = $this->getInputHTML( $value );
546 $fieldType = static::class;
547 $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
548 $cellAttributes = [];
549 $label = $this->getLabelHtml( $cellAttributes );
553 'mw-htmlform-nolabel' => ( $label === '' )
556 $horizontalLabel = $this->mParams
['horizontal-label'] ??
false;
558 if ( $horizontalLabel ) {
559 $field = "\u{00A0}" . $inputHtml . "\n$errors";
561 $field = Html
::rawElement(
563 [ 'class' => $outerDivClass ] +
$cellAttributes,
564 $inputHtml . "\n$errors"
567 $divCssClasses = [ "mw-htmlform-field-$fieldType",
568 $this->mClass
, $this->mVFormClass
, $errorClass ];
570 $wrapperAttributes = [
571 'class' => $divCssClasses,
573 if ( $this->mHideIf
) {
574 $wrapperAttributes['data-hide-if'] = FormatJson
::encode( $this->mHideIf
);
575 $wrapperAttributes['class'][] = ' mw-htmlform-hide-if';
577 $html = Html
::rawElement( 'div', $wrapperAttributes, $label . $field );
584 * Get the OOUI version of the div. Falls back to getDiv by default.
587 * @param string $value The value to set the input to.
589 * @return OOUI\FieldLayout|OOUI\ActionFieldLayout
591 public function getOOUI( $value ) {
592 $inputField = $this->getInputOOUI( $value );
594 if ( !$inputField ) {
595 // This field doesn't have an OOUI implementation yet at all. Fall back to getDiv() to
596 // generate the whole field, label and errors and all, then wrap it in a Widget.
597 // It might look weird, but it'll work OK.
598 return $this->getFieldLayoutOOUI(
599 new OOUI\
Widget( [ 'content' => new OOUI\
HtmlSnippet( $this->getDiv( $value ) ) ] ),
600 [ 'infusable' => false, 'align' => 'top' ]
605 if ( is_string( $inputField ) ) {
606 // We have an OOUI implementation, but it's not proper, and we got a load of HTML.
607 // Cheat a little and wrap it in a widget. It won't be infusable, though, since client-side
608 // JavaScript doesn't know how to rebuilt the contents.
609 $inputField = new OOUI\
Widget( [ 'content' => new OOUI\
HtmlSnippet( $inputField ) ] );
613 $fieldType = static::class;
614 $help = $this->getHelpText();
615 $errors = $this->getErrorsRaw( $value );
616 foreach ( $errors as &$error ) {
617 $error = new OOUI\
HtmlSnippet( $error );
620 $notices = $this->getNotices( 'skip deprecation' );
621 foreach ( $notices as &$notice ) {
622 $notice = new OOUI\
HtmlSnippet( $notice );
626 'classes' => [ "mw-htmlform-field-$fieldType", $this->mClass
],
627 'align' => $this->getLabelAlignOOUI(),
628 'help' => ( $help !== null && $help !== '' ) ?
new OOUI\
HtmlSnippet( $help ) : null,
630 'notices' => $notices,
631 'infusable' => $infusable,
632 'helpInline' => $this->isHelpInline(),
635 $preloadModules = false;
637 if ( $infusable && $this->shouldInfuseOOUI() ) {
638 $preloadModules = true;
639 $config['classes'][] = 'mw-htmlform-field-autoinfuse';
642 // the element could specify, that the label doesn't need to be added
643 $label = $this->getLabel();
644 if ( $label && $label !== "\u{00A0}" && $label !== ' ' ) {
645 $config['label'] = new OOUI\
HtmlSnippet( $label );
648 if ( $this->mHideIf
) {
649 $preloadModules = true;
650 $config['hideIf'] = $this->mHideIf
;
653 $config['modules'] = $this->getOOUIModules();
655 if ( $preloadModules ) {
656 $this->mParent
->getOutput()->addModules( 'mediawiki.htmlform.ooui' );
657 $this->mParent
->getOutput()->addModules( $this->getOOUIModules() );
660 return $this->getFieldLayoutOOUI( $inputField, $config );
664 * Get label alignment when generating field for OOUI.
665 * @return string 'left', 'right', 'top' or 'inline'
667 protected function getLabelAlignOOUI() {
672 * Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.
673 * @param string $inputField
674 * @param array $config
675 * @return OOUI\FieldLayout|OOUI\ActionFieldLayout
677 protected function getFieldLayoutOOUI( $inputField, $config ) {
678 if ( isset( $this->mClassWithButton
) ) {
679 $buttonWidget = $this->mClassWithButton
->getInputOOUI( '' );
680 return new HTMLFormActionFieldLayout( $inputField, $buttonWidget, $config );
682 return new HTMLFormFieldLayout( $inputField, $config );
686 * Whether the field should be automatically infused. Note that all OOUI HTMLForm fields are
687 * infusable (you can call OO.ui.infuse() on them), but not all are infused by default, since
688 * there is no benefit in doing it e.g. for buttons and it's a small performance hit on page load.
692 protected function shouldInfuseOOUI() {
693 // Always infuse fields with popup help text, since the interface for it is nicer with JS
694 return $this->getHelpText() !== null && !$this->isHelpInline();
698 * Get the list of extra ResourceLoader modules which must be loaded client-side before it's
699 * possible to infuse this field's OOUI widget.
703 protected function getOOUIModules() {
708 * Get the complete raw fields for the input, including help text,
709 * labels, and whatever.
712 * @param string $value The value to set the input to.
714 * @return string Complete HTML table row.
716 public function getRaw( $value ) {
717 list( $errors, ) = $this->getErrorsAndErrorClass( $value );
718 $inputHtml = $this->getInputHTML( $value );
719 $helptext = $this->getHelpTextHtmlRaw( $this->getHelpText() );
720 $cellAttributes = [];
721 $label = $this->getLabelHtml( $cellAttributes );
732 * Get the complete field for the input, including help text,
733 * labels, and whatever. Fall back from 'vform' to 'div' when not overridden.
736 * @param string $value The value to set the input to.
737 * @return string Complete HTML field.
739 public function getVForm( $value ) {
741 $this->mVFormClass
= ' mw-ui-vform-field';
742 return $this->getDiv( $value );
746 * Get the complete field as an inline element.
748 * @param string $value The value to set the input to.
749 * @return string Complete HTML inline element
751 public function getInline( $value ) {
752 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
753 $inputHtml = $this->getInputHTML( $value );
754 $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
755 $cellAttributes = [];
756 $label = $this->getLabelHtml( $cellAttributes );
758 $html = "\n" . $errors .
759 $label . "\u{00A0}" .
767 * Generate help text HTML in table format
770 * @param string|null $helptext
773 public function getHelpTextHtmlTable( $helptext ) {
774 if ( is_null( $helptext ) ) {
779 if ( $this->mHideIf
) {
780 $rowAttributes['data-hide-if'] = FormatJson
::encode( $this->mHideIf
);
781 $rowAttributes['class'] = 'mw-htmlform-hide-if';
784 $tdClasses = [ 'htmlform-tip' ];
785 if ( $this->mHelpClass
!== false ) {
786 $tdClasses[] = $this->mHelpClass
;
788 $row = Html
::rawElement( 'td', [ 'colspan' => 2, 'class' => $tdClasses ], $helptext );
789 $row = Html
::rawElement( 'tr', $rowAttributes, $row );
795 * Generate help text HTML in div format
798 * @param string|null $helptext
802 public function getHelpTextHtmlDiv( $helptext ) {
803 if ( is_null( $helptext ) ) {
807 $wrapperAttributes = [
808 'class' => 'htmlform-tip',
810 if ( $this->mHelpClass
!== false ) {
811 $wrapperAttributes['class'] .= " {$this->mHelpClass}";
813 if ( $this->mHideIf
) {
814 $wrapperAttributes['data-hide-if'] = FormatJson
::encode( $this->mHideIf
);
815 $wrapperAttributes['class'] .= ' mw-htmlform-hide-if';
817 $div = Html
::rawElement( 'div', $wrapperAttributes, $helptext );
823 * Generate help text HTML formatted for raw output
826 * @param string|null $helptext
829 public function getHelpTextHtmlRaw( $helptext ) {
830 return $this->getHelpTextHtmlDiv( $helptext );
834 * Determine the help text to display
836 * @return string|null HTML
838 public function getHelpText() {
841 if ( isset( $this->mParams
['help-message'] ) ) {
842 $this->mParams
['help-messages'] = [ $this->mParams
['help-message'] ];
845 if ( isset( $this->mParams
['help-messages'] ) ) {
846 foreach ( $this->mParams
['help-messages'] as $msg ) {
847 $msg = $this->getMessage( $msg );
849 if ( $msg->exists() ) {
850 if ( is_null( $helptext ) ) {
853 $helptext .= $this->msg( 'word-separator' )->escaped(); // some space
855 $helptext .= $msg->parse(); // Append message
858 } elseif ( isset( $this->mParams
['help'] ) ) {
859 $helptext = $this->mParams
['help'];
866 * Determine if the help text should be displayed inline.
868 * Only applies to OOUI forms.
873 public function isHelpInline() {
874 return $this->mParams
['help-inline'] ??
true;
878 * Determine form errors to display and their classes
881 * phan-taint-check gets confused with returning both classes
882 * and errors and thinks double escaping is happening, so specify
883 * that return value has no taint.
885 * @param string $value The value of the input
886 * @return array array( $errors, $errorClass )
889 public function getErrorsAndErrorClass( $value ) {
890 $errors = $this->validate( $value, $this->mParent
->mFieldData
);
892 if ( is_bool( $errors ) ||
!$this->mParent
->wasSubmitted() ) {
896 $errors = self
::formatErrors( $errors );
897 $errorClass = 'mw-htmlform-invalid-input';
900 return [ $errors, $errorClass ];
904 * Determine form errors to display, returning them in an array.
907 * @param string $value The value of the input
908 * @return string[] Array of error HTML strings
910 public function getErrorsRaw( $value ) {
911 $errors = $this->validate( $value, $this->mParent
->mFieldData
);
913 if ( is_bool( $errors ) ||
!$this->mParent
->wasSubmitted() ) {
917 if ( !is_array( $errors ) ) {
918 $errors = [ $errors ];
920 foreach ( $errors as &$error ) {
921 if ( $error instanceof Message
) {
922 $error = $error->parse();
930 * Determine notices to display for the field.
933 * @deprecated since 1.32
934 * @param string $skipDeprecation Pass 'skip deprecation' to avoid the deprecation
935 * warning (since 1.32)
938 public function getNotices( $skipDeprecation = null ) {
939 if ( $skipDeprecation !== 'skip deprecation' ) {
940 wfDeprecated( __METHOD__
, '1.32' );
945 if ( isset( $this->mParams
['notice-message'] ) ) {
946 $notices[] = $this->getMessage( $this->mParams
['notice-message'] )->parse();
949 if ( isset( $this->mParams
['notice-messages'] ) ) {
950 foreach ( $this->mParams
['notice-messages'] as $msg ) {
951 $notices[] = $this->getMessage( $msg )->parse();
953 } elseif ( isset( $this->mParams
['notice'] ) ) {
954 $notices[] = $this->mParams
['notice'];
961 * @return string HTML
963 public function getLabel() {
964 return $this->mLabel ??
'';
967 public function getLabelHtml( $cellAttributes = [] ) {
968 # Don't output a for= attribute for labels with no associated input.
969 # Kind of hacky here, possibly we don't want these to be <label>s at all.
972 if ( $this->needsLabel() ) {
973 $for['for'] = $this->mID
;
976 $labelValue = trim( $this->getLabel() );
978 if ( $labelValue !== "\u{00A0}" && $labelValue !== ' ' && $labelValue !== '' ) {
982 $displayFormat = $this->mParent
->getDisplayFormat();
984 $horizontalLabel = $this->mParams
['horizontal-label'] ??
false;
986 if ( $displayFormat === 'table' ) {
988 Html
::rawElement( 'td',
989 [ 'class' => 'mw-label' ] +
$cellAttributes,
990 Html
::rawElement( 'label', $for, $labelValue ) );
991 } elseif ( $hasLabel ||
$this->mShowEmptyLabels
) {
992 if ( $displayFormat === 'div' && !$horizontalLabel ) {
994 Html
::rawElement( 'div',
995 [ 'class' => 'mw-label' ] +
$cellAttributes,
996 Html
::rawElement( 'label', $for, $labelValue ) );
998 $html = Html
::rawElement( 'label', $for, $labelValue );
1005 public function getDefault() {
1006 return $this->mDefault ??
null;
1010 * Returns the attributes required for the tooltip and accesskey, for Html::element() etc.
1012 * @return array Attributes
1014 public function getTooltipAndAccessKey() {
1015 if ( empty( $this->mParams
['tooltip'] ) ) {
1019 return Linker
::tooltipAndAccesskeyAttribs( $this->mParams
['tooltip'] );
1023 * Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.
1025 * @return array Attributes
1027 public function getTooltipAndAccessKeyOOUI() {
1028 if ( empty( $this->mParams
['tooltip'] ) ) {
1033 'title' => Linker
::titleAttrib( $this->mParams
['tooltip'] ),
1034 'accessKey' => Linker
::accesskey( $this->mParams
['tooltip'] ),
1039 * Returns the given attributes from the parameters
1041 * @param array $list List of attributes to get
1042 * @return array Attributes
1044 public function getAttributes( array $list ) {
1045 static $boolAttribs = [ 'disabled', 'required', 'autofocus', 'multiple', 'readonly' ];
1048 foreach ( $list as $key ) {
1049 if ( in_array( $key, $boolAttribs ) ) {
1050 if ( !empty( $this->mParams
[$key] ) ) {
1053 } elseif ( isset( $this->mParams
[$key] ) ) {
1054 $ret[$key] = $this->mParams
[$key];
1062 * Given an array of msg-key => value mappings, returns an array with keys
1063 * being the message texts. It also forces values to strings.
1065 * @param array $options
1068 private function lookupOptionsKeys( $options ) {
1070 foreach ( $options as $key => $value ) {
1071 $key = $this->msg( $key )->plain();
1072 $ret[$key] = is_array( $value )
1073 ?
$this->lookupOptionsKeys( $value )
1080 * Recursively forces values in an array to strings, because issues arise
1081 * with integer 0 as a value.
1083 * @param array $array
1084 * @return array|string
1086 public static function forceToStringRecursive( $array ) {
1087 if ( is_array( $array ) ) {
1088 return array_map( [ __CLASS__
, 'forceToStringRecursive' ], $array );
1090 return strval( $array );
1095 * Fetch the array of options from the field's parameters. In order, this
1096 * checks 'options-messages', 'options', then 'options-message'.
1098 * @return array|null Options array
1100 public function getOptions() {
1101 if ( $this->mOptions
=== false ) {
1102 if ( array_key_exists( 'options-messages', $this->mParams
) ) {
1103 $this->mOptions
= $this->lookupOptionsKeys( $this->mParams
['options-messages'] );
1104 } elseif ( array_key_exists( 'options', $this->mParams
) ) {
1105 $this->mOptionsLabelsNotFromMessage
= true;
1106 $this->mOptions
= self
::forceToStringRecursive( $this->mParams
['options'] );
1107 } elseif ( array_key_exists( 'options-message', $this->mParams
) ) {
1108 $message = $this->getMessage( $this->mParams
['options-message'] )->inContentLanguage()->plain();
1109 $this->mOptions
= Xml
::listDropDownOptions( $message );
1111 $this->mOptions
= null;
1115 return $this->mOptions
;
1119 * Get options and make them into arrays suitable for OOUI.
1120 * @return array Options for inclusion in a select or whatever.
1122 public function getOptionsOOUI() {
1123 $oldoptions = $this->getOptions();
1125 if ( $oldoptions === null ) {
1129 return Xml
::listDropDownOptionsOoui( $oldoptions );
1133 * flatten an array of options to a single array, for instance,
1134 * a set of "<options>" inside "<optgroups>".
1136 * @param array $options Associative Array with values either Strings or Arrays
1137 * @return array Flattened input
1139 public static function flattenOptions( $options ) {
1142 foreach ( $options as $value ) {
1143 if ( is_array( $value ) ) {
1144 $flatOpts = array_merge( $flatOpts, self
::flattenOptions( $value ) );
1146 $flatOpts[] = $value;
1154 * Formats one or more errors as accepted by field validation-callback.
1156 * @param string|Message|array $errors Array of strings or Message instances
1157 * To work around limitations in phan-taint-check the calling
1158 * class has taintedness disabled. So instead we pretend that
1159 * this method outputs html, since the result is eventually
1160 * outputted anyways without escaping and this allows us to verify
1161 * stuff is safe even though the caller has taintedness cleared.
1162 * @param-taint $errors exec_html
1163 * @return string HTML
1166 protected static function formatErrors( $errors ) {
1167 // Note: If you change the logic in this method, change
1168 // htmlform.Checker.js to match.
1170 if ( is_array( $errors ) && count( $errors ) === 1 ) {
1171 $errors = array_shift( $errors );
1174 if ( is_array( $errors ) ) {
1176 foreach ( $errors as $error ) {
1177 if ( $error instanceof Message
) {
1178 $lines[] = Html
::rawElement( 'li', [], $error->parse() );
1180 $lines[] = Html
::rawElement( 'li', [], $error );
1184 return Html
::rawElement( 'ul', [ 'class' => 'error' ], implode( "\n", $lines ) );
1186 if ( $errors instanceof Message
) {
1187 $errors = $errors->parse();
1190 return Html
::rawElement( 'span', [ 'class' => 'error' ], $errors );
1195 * Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a
1196 * name + parameters array) into a Message.
1197 * @param mixed $value
1200 protected function getMessage( $value ) {
1201 $message = Message
::newFromSpecifier( $value );
1203 if ( $this->mParent
) {
1204 $message->setContext( $this->mParent
);
1211 * Skip this field when collecting data.
1212 * @param WebRequest $request
1216 public function skipLoadData( $request ) {
1217 return !empty( $this->mParams
['nodata'] );
1221 * Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5
1222 * form validation to work correctly.
1227 public function needsJSForHtml5FormValidation() {
1228 if ( $this->mHideIf
) {
1229 // This is probably more restrictive than it needs to be, but better safe than sorry